// ============================================================================
//
// LCP-net framework by Pierre CHATEL chatelp@gmail.com
// Distributed under GPLv3
// Copyright (C) THALES Land & Joint Systems, 2008, 2009. All rights reserved
//
// ============================================================================

/**
 * <copyright>
 * </copyright>
 *
 * $Id$
 */
package com.thalesgroup.preferenceFramework.models;

import com.thalesgroup.preferenceFramework.models.exceptions.PreferenceException;
import org.eclipse.emf.common.util.EList;

import org.eclipse.emf.ecore.EObject;

/**
 * <!-- begin-user-doc --> A representation of the model object '
 * <em><b>Outcome</b></em>'. <!-- end-user-doc -->
 *
 * <p>
 * The following features are supported:
 * <ul>
 *   <li>{@link com.thalesgroup.preferenceFramework.models.Outcome#getPreferenceNetwork <em>Preference Network</em>}</li>
 *   <li>{@link com.thalesgroup.preferenceFramework.models.Outcome#getNodeValues <em>Node Values</em>}</li>
 * </ul>
 * </p>
 *
 * @see com.thalesgroup.preferenceFramework.models.ModelsPackage#getOutcome()
 * @model abstract="true"
 * @generated
 */
public interface Outcome extends Namable {
	/**
	 * Returns the value of the '<em><b>Preference Network</b></em>' container reference.
	 * It is bidirectional and its opposite is '{@link com.thalesgroup.preferenceFramework.models.PreferenceNetwork#getOutcomes <em>Outcomes</em>}'.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Preference Network</em>' container reference
	 * isn't clear, there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Preference Network</em>' container reference.
	 * @see #setPreferenceNetwork(PreferenceNetwork)
	 * @see com.thalesgroup.preferenceFramework.models.ModelsPackage#getOutcome_PreferenceNetwork()
	 * @see com.thalesgroup.preferenceFramework.models.PreferenceNetwork#getOutcomes
	 * @model opposite="outcomes" transient="false"
	 * @generated
	 */
	PreferenceNetwork getPreferenceNetwork();

	/**
	 * Sets the value of the '{@link com.thalesgroup.preferenceFramework.models.Outcome#getPreferenceNetwork <em>Preference Network</em>}' container reference.
	 * <!-- begin-user-doc
	 * --> <!-- end-user-doc -->
	 * @param value the new value of the '<em>Preference Network</em>' container reference.
	 * @see #getPreferenceNetwork()
	 * @generated
	 */
	void setPreferenceNetwork(PreferenceNetwork value);

	/**
	 * Returns the value of the '<em><b>Node Values</b></em>' reference list.
	 * The list contents are of type
	 * {@link com.thalesgroup.preferenceFramework.models.NodeValue}. <!--
	 * begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Node Values</em>' reference list isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * 
	 * @return the value of the '<em>Node Values</em>' reference list.
	 * @see com.thalesgroup.preferenceFramework.models.ModelsPackage#getOutcome_NodeValues()
	 * @model required="true"
	 * @generated
	 */
	EList<NodeValue> getNodeValues();

	/**
	 * Returns the NodeValue associated to this node in this outcome.
	 * 
	 * @return the associated NodeValue or null if node is not found.
	 * @model nodeRequired="true"
	 * @generated
	 */
	NodeValue getNodeValue(Node node) throws PreferenceException;

	/**
	 * This is an utility method for algorithmic usage. It returns the list of
	 * parents values for the given child node value.
	 * 
	 * @param childNodeValue
	 *            the originating node value
	 * @return the set of parent node values
	 * @model childNodeValueRequired="true"
	 * @generated NOT
	 */
	EList<NodeValue> getParentValues(NodeValue childNodeValue);

} // Outcome
